DOC-884: Update Okta Documentation for SAML #1634

wcrum · 2023-10-02T21:32:25Z

Describe the Change

This PR updates the Okta documentation with a step-by-step guide on how to configure SAML.

Review Changes

netlify · 2023-10-02T21:32:29Z

✅ Deploy Preview for docs-spectrocloud ready!

Name	Link
🔨 Latest commit	`20812de`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spectrocloud/deploys/651cc10af91b500008f399ac
😎 Deploy Preview	https://deploy-preview-1634--docs-spectrocloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md

github-actions · 2023-10-02T21:33:16Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md

+  <br />
+
+  :::info
+  Due to some browsers that add additional formatting and spacing for XML data, you can run the below command to copy the contents to your clipboard.


🚫 [vale] _{reported by reviewdog 🐶}
[spectrocloud.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.

docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md

github-actions · 2023-10-02T21:35:28Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 32.9%, saving 329.99 KB.

Filename	Before	After	Improvement	Visual comparison
`static/assets/docs/images/saml-okta-images/okta-create-application.png`	92.40 KB	65.41 KB	-29.2%	View diff
`static/assets/docs/images/saml-okta-images/okta-metadata-url.png`	151.70 KB	104.61 KB	-31.0%	View diff
`static/assets/docs/images/saml-okta-images/okta-saml-attribute-statements.png`	100.95 KB	72.99 KB	-27.7%	View diff
`static/assets/docs/images/saml-okta-images/okta-saml-general-settings.png`	133.17 KB	86.63 KB	-35.0%	View diff
`static/assets/docs/images/saml-okta-images/palette-manage-sso-okta-metadata.png`	300.44 KB	196.72 KB	-34.5%	View diff
`static/assets/docs/images/saml-okta-images/palette-manage-sso-okta-saml.png`	223.22 KB	145.54 KB	-34.8%	View diff

480 images did not require optimisation.

…rocloud/librarium into will-okta-saml-documentation

github-actions · 2023-10-02T21:47:54Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md

+
+  <br />
+
+6. Switch back to your Okta Admin console and paste the copied value to the **Single sign-on URL** and **Audience URI (SP Entity ID)**.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-02T21:47:54Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md

+
+  <br />
+
+6. Switch back to your Okta Admin console and paste the copied value to the **Single sign-on URL** and **Audience URI (SP Entity ID)**.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Terms] Use 'admin' instead of 'Admin'.

karl-cardenas-coding

Awesome PR @wcrum . I'm gonna setup a short meeting to go over the things missing to get this over the fence. Thanks again for writing this up.

docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md

- renamed all files based on standard - separated oidc / saml documentation - added validation / team creation for okta saml

wcrum · 2023-10-03T22:21:45Z

@karl-cardenas-coding updated based on review on call.

github-actions · 2023-10-03T22:21:51Z

docs/docs-content/user-management/saml-sso/saml-sso.md

@@ -32,4 +32,7 @@ Enable SSO by following our [Enable SSO in Palette](enable-saml.md) guide.
 - [Enable SSO with Microsoft Active Directory Federation Service (AD FS)](palette-sso-with-adfs.md)


- [Palette SSO with Okta](palette-sso-with-okta.md)
+- [Palette SSO with Okta OIDC](palette-sso-with-okta-oidc.md)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:51Z

docs/docs-content/user-management/saml-sso/saml-sso.md

+- [Palette SSO with Okta OIDC](palette-sso-with-okta-oidc.md)
+
+
+- [Palette SSO with Okta SAML](palette-sso-with-okta-saml.md)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:51Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-saml.md

+
+
+
+# Enable SSO with Okta SAML


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:51Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-saml.md

+
+Single Sign-On (SSO) is an authentication method that enables users to log in to multiple applications and websites with one set of credentials. SSO uses certificates to establish and maintain a trust relationship between the Service Provider (SP) and an Identity Provider (IdP). Palette supports SSO based on either the Security Assertion Markup Language (SAML) or OpenID Connect (OIDC).
+
+The following steps will guide you on how to enable Palette SSO with [Okta Workforce Identity Cloud](https://www.okta.com/products/single-sign-on/) based on SAML.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:51Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-saml.md

+
+## Prerequisites
+
+- You need to have either a free or paid subscription with Okta. Okta provides free [developer subscriptions](https://developer.okta.com/signup/) for testing purposes.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:53Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-saml.md

+
+## Resources
+
+- [Okta Workforce Identity Cloud](https://www.okta.com/products/single-sign-on/)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:53Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-oidc.md

 ---





-# Enable SSO with Okta
+# Enable SSO with Okta OIDC


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:53Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-oidc.md

@@ -28,8 +28,9 @@ The following steps will guide you on how to enable Palette SSO with [Okta Workf
 - If you want to use the same Okta application for OIDC-based SSO into your Kubernetes cluster itself, you need to install [kubelogin](https://github.com/int128/kubelogin) on your local workstation to handle retrieval of access tokens for your cluster.


-## Enablement
-## Create the Okta Application
+## Okta with OIDC


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:53Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-oidc.md

-## Create the Okta Application
+## Okta with OIDC
+
+### Create the Okta Application


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-03T22:21:53Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-oidc.md

@@ -124,7 +125,7 @@ The following steps will guide you on how to enable Palette SSO with [Okta Workf

 <br />

-## Create an Okta Authorization Server
+### Create an Okta Authorization Server


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-04T01:34:02Z

docs/docs-content/user-management/saml-sso/saml-sso.md

@@ -32,4 +32,7 @@ Enable SSO by following our [Enable SSO in Palette](enable-saml.md) guide.
 - [Enable SSO with Microsoft Active Directory Federation Service (AD FS)](palette-sso-with-adfs.md)


- [Palette SSO with Okta](palette-sso-with-okta.md)
+- [Palette SSO with Okta OIDC](palette-sso-with-okta.md)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-04T01:34:02Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-saml.md

+
+  <br />
+
+  ![Create Okta Application](/saml-okta-images/user-management_saml-sso_palette-sso-with-okta-saml_create-application.png)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-04T01:34:02Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-saml.md

+
+  <br />
+
+  ![Configure Okta General Settings](/saml-okta-images/user-management_saml-sso_palette-sso-with-okta-saml_general-settings.png)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-04T01:34:02Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-saml.md

+
+  <br />
+
+  ![Copy Okta SAML Metadata](/saml-okta-images/user-management_saml-sso_palette-sso-with-okta-saml_metadata-url.png)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

github-actions · 2023-10-04T01:34:02Z

docs/docs-content/user-management/saml-sso/palette-sso-with-okta-saml.md

+
+### Validate
+
+1. Log in to Palette through SSO as an Okta user who is a member of the Okta application to verify SSO. If you are still logged into Palette with a non-SSO user, log out by selecting **Logout** in the **User Menu** at the top right.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Okta'?

karl-cardenas-coding

Thanks for the PR @wcrum

* Update Okta Documentation for SAML * Optimised images with calibre/image-actions * Fix spelling * Fix spelling * Update Okta SAML Documentation - renamed all files based on standard - separated oidc / saml documentation - added validation / team creation for okta saml * docs: fixed images names and prevented redirect need --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Karl Cardenas <karl@spectrocloud.com> (cherry picked from commit 9909d5d)

vault-token-factory-spectrocloud · 2023-10-04T01:51:38Z

💔 Some backports could not be created

Status	Branch	Result
✅	version-4-0
❌	version-3-4	Backport failed because of merge conflicts You might need to backport the following PRs to version-3-4: - docs: updated URLs to use file path context

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 1634

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

karl-cardenas-coding · 2023-10-04T02:01:42Z

PR #1644 fixes the broken backport attempt for version 3.4

* Update Okta Documentation for SAML * Optimised images with calibre/image-actions * Fix spelling * Fix spelling * Update Okta SAML Documentation - renamed all files based on standard - separated oidc / saml documentation - added validation / team creation for okta saml * docs: fixed images names and prevented redirect need --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Karl Cardenas <karl@spectrocloud.com> (cherry picked from commit 9909d5d) Co-authored-by: Will <30413278+wcrum@users.noreply.github.com>

* Update Okta Documentation for SAML * Optimised images with calibre/image-actions * Fix spelling * Fix spelling * Update Okta SAML Documentation - renamed all files based on standard - separated oidc / saml documentation - added validation / team creation for okta saml * docs: fixed images names and prevented redirect need --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

Update Okta Documentation for SAML

eae27fa

wcrum requested a review from a team as a code owner October 2, 2023 21:32

wcrum requested review from karl-cardenas-coding and ritawatson October 2, 2023 21:32

github-actions bot reviewed Oct 2, 2023

View reviewed changes

Optimised images with calibre/image-actions

b8b9a87

wcrum added 3 commits October 2, 2023 15:45

Fix spelling

c95087f

Merge branch 'will-okta-saml-documentation' of ssh://github.com/spect…

151b9b2

…rocloud/librarium into will-okta-saml-documentation

Fix spelling

03998d4

github-actions bot reviewed Oct 2, 2023

View reviewed changes

wcrum changed the title ~~Update Okta Documentation for SAML~~ DOC-884: Update Okta Documentation for SAML Oct 3, 2023

karl-cardenas-coding requested changes Oct 3, 2023

View reviewed changes

docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md Outdated Show resolved Hide resolved

docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md Outdated Show resolved Hide resolved

Update Okta SAML Documentation

f455a41

- renamed all files based on standard - separated oidc / saml documentation - added validation / team creation for okta saml

wcrum requested a review from karl-cardenas-coding October 3, 2023 22:21

github-actions bot reviewed Oct 3, 2023

View reviewed changes

karl-cardenas-coding added 2 commits October 3, 2023 18:32

docs: fixed images names and prevented redirect need

5146014

Merge branch 'master' into will-okta-saml-documentation

20812de

github-actions bot reviewed Oct 4, 2023

View reviewed changes

karl-cardenas-coding added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 labels Oct 4, 2023

karl-cardenas-coding approved these changes Oct 4, 2023

View reviewed changes

karl-cardenas-coding merged commit 9909d5d into master Oct 4, 2023
12 checks passed

karl-cardenas-coding deleted the will-okta-saml-documentation branch October 4, 2023 01:51

vault-token-factory-spectrocloud bot mentioned this pull request Oct 4, 2023

[version-4-0] docs: update Okta Documentation for SAML (#1634) DOC-884 #1643

Merged

karl-cardenas-coding mentioned this pull request Oct 4, 2023

[version-3-4] Backport/version 3 4/pr 1634 #1644

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Jul 12, 2024

Fix markup and alignment in User Management (SSO) and add HTTPS and TLS requirements #3345

Merged

2 tasks

vault-token-factory-spectrocloud bot mentioned this pull request Nov 22, 2024

User Management Refactor #4712

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC-884: Update Okta Documentation for SAML #1634

DOC-884: Update Okta Documentation for SAML #1634

wcrum commented Oct 2, 2023

netlify bot commented Oct 2, 2023 •

edited

Loading

github-actions bot Oct 2, 2023

github-actions bot commented Oct 2, 2023

github-actions bot Oct 2, 2023

github-actions bot Oct 2, 2023

karl-cardenas-coding left a comment

wcrum commented Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 3, 2023

github-actions bot Oct 4, 2023

github-actions bot Oct 4, 2023

github-actions bot Oct 4, 2023

github-actions bot Oct 4, 2023

github-actions bot Oct 4, 2023

karl-cardenas-coding left a comment

vault-token-factory-spectrocloud bot commented Oct 4, 2023

karl-cardenas-coding commented Oct 4, 2023


		<br />

		6. Switch back to your Okta Admin console and paste the copied value to the Single sign-on URL and Audience URI (SP Entity ID).

		- [Palette SSO with Okta OIDC](palette-sso-with-okta-oidc.md)


		- [Palette SSO with Okta SAML](palette-sso-with-okta-saml.md)


		Single Sign-On (SSO) is an authentication method that enables users to log in to multiple applications and websites with one set of credentials. SSO uses certificates to establish and maintain a trust relationship between the Service Provider (SP) and an Identity Provider (IdP). Palette supports SSO based on either the Security Assertion Markup Language (SAML) or OpenID Connect (OIDC).

		The following steps will guide you on how to enable Palette SSO with [Okta Workforce Identity Cloud](https://www.okta.com/products/single-sign-on/) based on SAML.


		## Prerequisites

		- You need to have either a free or paid subscription with Okta. Okta provides free [developer subscriptions](https://developer.okta.com/signup/) for testing purposes.


		## Resources

		- [Okta Workforce Identity Cloud](https://www.okta.com/products/single-sign-on/)


		<br />

		![Create Okta Application](/saml-okta-images/user-management_saml-sso_palette-sso-with-okta-saml_create-application.png)


		<br />

		![Configure Okta General Settings](/saml-okta-images/user-management_saml-sso_palette-sso-with-okta-saml_general-settings.png)


		<br />

		![Copy Okta SAML Metadata](/saml-okta-images/user-management_saml-sso_palette-sso-with-okta-saml_metadata-url.png)


		### Validate

		1. Log in to Palette through SSO as an Okta user who is a member of the Okta application to verify SSO. If you are still logged into Palette with a non-SSO user, log out by selecting Logout in the User Menu at the top right.

DOC-884: Update Okta Documentation for SAML #1634

DOC-884: Update Okta Documentation for SAML #1634

Conversation

wcrum commented Oct 2, 2023

Describe the Change

Review Changes

netlify bot commented Oct 2, 2023 • edited Loading

✅ Deploy Preview for docs-spectrocloud ready!

github-actions bot Oct 2, 2023

Choose a reason for hiding this comment

github-actions bot commented Oct 2, 2023

github-actions bot Oct 2, 2023

Choose a reason for hiding this comment

github-actions bot Oct 2, 2023

Choose a reason for hiding this comment

karl-cardenas-coding left a comment

Choose a reason for hiding this comment

wcrum commented Oct 3, 2023

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot Oct 4, 2023

Choose a reason for hiding this comment

github-actions bot Oct 4, 2023

Choose a reason for hiding this comment

github-actions bot Oct 4, 2023

Choose a reason for hiding this comment

github-actions bot Oct 4, 2023

Choose a reason for hiding this comment

github-actions bot Oct 4, 2023

Choose a reason for hiding this comment

karl-cardenas-coding left a comment

Choose a reason for hiding this comment

vault-token-factory-spectrocloud bot commented Oct 4, 2023

💔 Some backports could not be created

Manual backport

Questions ?

karl-cardenas-coding commented Oct 4, 2023

netlify bot commented Oct 2, 2023 •

edited

Loading